/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.shenyu.common.dto.convert.rule;

import org.apache.shenyu.common.utils.GsonUtils;

import java.io.Serializable;

/**
 * The RuleHandle interface.
 */
public interface RuleHandle extends Serializable {

    /**
     * It will be call when RuleHandleFactory to generate a RuleHandle object.
     * @param path  path.
     * @return      it's self.
     */
    RuleHandle createDefault(String path);

    /**
     * Format this object to json string.
     * @return      json string.
     */
    default String toJson() {
        return GsonUtils.getGson().toJson(this);
    }
}
